home *** CD-ROM | disk | FTP | other *** search
/ QRZ! Ham Radio 8 / QRZ Ham Radio Callsign Database - Volume 8.iso / pc / files / misc / hb305.exe / EXPERT.DOC < prev    next >
Text File  |  1993-01-24  |  17KB  |  442 lines
  1.  
  2. This section contains information of use to HamBase owners who
  3. wish to know more about some of the more complicated features of
  4. the program.  HamBase can be used very successfully without 
  5. reading this document.
  6.  
  7. On the other hand, HamBase has many capabilities which are available
  8. to the enthusiastic informed user who wants to explore and experiment
  9. a little.  This information may be of use to such users.
  10.  
  11. Always have backups available that you can return to if something
  12. gets screwed up.  If you are going to experiment, you should try
  13. and understand what it is you are doing.  Whether you understand or not,
  14. something can still go wrong.  If it does, you need to be in a position
  15. to undo what you have done and revert to what you know worked before.
  16.  
  17. In the worst case, you can always re-install the entire package from
  18. the distribution diskettes.
  19.  
  20. Occasionally an error may occur which can be fixed with a text editor
  21. and a simple change to the HAMBASE.CFG file, or the HB93.MAP file.
  22.  
  23. INSTALL.LOG
  24. -----------
  25.  
  26. As the installation proceeds errors are saved to the file INSTALL.LOG
  27. in the destination directory. This information can be useful for diagnosing
  28. errors which may have occurred during the installation.
  29.  
  30. The Configuration File
  31. ----------------------
  32.  
  33. HAMBASE.CFG is the configuration file which tells the program which
  34. options to use.  It is a text file, and can be edited with any
  35. ASCII text editor which does not insert control characters or document
  36. instructions.
  37.  
  38. ALWAYS back up HAMBASE.CFG before making any changes.  If something goes
  39. wrong, you can always revert to the original working version.
  40.  
  41. In general, instructions to HamBase are in the following form:
  42.  
  43.     OWNER=WA9L
  44.     
  45. These lines must contain no spaces between the variable name and the =
  46. sign, or between the = sign and the assigned value.
  47.  
  48. A comment above each instruction describes what it does.  If the CFG file
  49. gets corrupted and HamBase starts to act strangely, check for missing
  50. or duplicated variables.  Compare the HAMBASE.CFG file on the distribution
  51. diskette with the one you are now using.  The CFG file actually being
  52. used is displayed as the first line in the display produced by the
  53. CONFIGURE | VIEW DATA FILES menu selection.
  54.  
  55. You can easily look at the CFG file from within HamBase with the BROWSE
  56. TEXT command.
  57.  
  58. OWNER= j-Com 
  59.  
  60. Up to 10 characters can be used for the owner name.  Spaces are allowed.
  61. Some special ascii characters will work, others will not.  Experiment if
  62. you like.  At some time in the future, we are hoping to institute a modem
  63. subscription data service.  If we do this, the data will be encrypted and
  64. only usable if you use your call sign and a special password which we will
  65. send you.
  66.  
  67. STARTUP=LOOKUP
  68.  
  69. If you set this command, HamBase will go directly to the callsign lookup
  70. function without stopping for the first menu.  You can return to the
  71. menu structure with the Esc key.
  72.  
  73. PATH1=C:\HAMBASE
  74. PATH2=
  75. PATH3=
  76. PATH4=
  77. PATH5=
  78. PATH6=
  79.                 
  80. These paths can be filled in from the CONFIGURE | DATA FILES | GENERATE
  81. DATA MAP menu item.  They must be valid paths on your disk drive, or
  82. refer to a drive properly configured in your CMOS as removable.  Look
  83. for duplication of these variables if HamBase acts strangely.  They must
  84. appear only once in the HAMBASE.CFG file.
  85.  
  86. COLOR0=BROWN
  87. COLOR1=GREEN
  88. COLOR2=RED
  89. COLOR3=YELLOW
  90. COLOR4=BLUE
  91. COLOR5=WHITE
  92. COLOR6=CYAN
  93. COLOR7=BLACK
  94. COLOR8=WHITE
  95. COLOR9=BLACK
  96.  
  97. These are the color selections used.  They are explained in CONFIGURE |
  98. COLORS.  Press F1 for a description of the order of color selection.
  99.  
  100. REM========================================|
  101. QSL1=Confirming a 20 m SSB QSO with $CALL$
  102. QSL2=At $HR$:$MIN$z on $MON$ $DAY$, $YR$
  103. QSL3=Please QSL Thank you.  -73-
  104. QSL4=
  105. REM========================================|
  106.  
  107. The information for the four lines of the QSL label.  The maximum line length
  108. is indicated in the surrounding REM statements.
  109.  
  110. COUNTY=C:\HAMBASE\HBCOUNTY.A
  111.  
  112. The path to the county name data.
  113.  
  114. NAMES=C:\HAMBASE\USA.IDX
  115.  
  116. The path to the name index currently in use.
  117.  
  118. NEW=C:\HAMBASE\HBNEW.A
  119.  
  120. The path to the file that new data will be added to.
  121.  
  122. HELP=C:\HB93\HAMBASE.HLX
  123.  
  124. The path to the help screens.
  125.  
  126. PRINTFILE=PRN
  127. PRINTTOP=1
  128. PRINTBOTTOM=2
  129. PRINTLEFT=5
  130.  
  131. The printer file or device and the margin settings.
  132.  
  133. MAP=C:\HAMBASE\HB93.MAP
  134.  
  135. The path to the map of files used by HamBase 3.0.
  136.  
  137. MAP FILES
  138. ---------
  139.  
  140. HamBase 2.x used the file HB92.MAP for its map.  HamBase 1.x used the file 
  141. HAMBASE.MAP for its map.  Some logging and BBS software may make use of the
  142. earlier MAP format to access the data directly.  If this is the case, you will
  143. only be able to access as much information as was available in that
  144. earlier version.
  145.  
  146. For example, users of Pavilion Software's DX Spotting Network were still
  147. restricted to accessing the data from version 1.0 of HamBase at the
  148. time of writing this document.  That means that UPDATE files, HBTEXT files,
  149. and county data could not be accessed.
  150.  
  151. HamWindows uses HB92.MAP as of this writing and can access UPDATE and
  152. HBTEXT data, but not HBNEW.A file data.
  153.  
  154. When you Generate Map Files, the HAMBASE.MAP AND HB92.MAP files are also
  155. generated for compatibility.
  156.  
  157.  
  158. HB93.MAP
  159. --------
  160.         
  161. This is the map HamBase uses to find its way through the data files.  It
  162. searches the files in the order they are shown in this map.  Although we
  163. recommend a certain order, there is no reason why you couldn't change the
  164. search order if a different one were convenient for your application.
  165.  
  166. A typical HB93.MAP file might look like this:
  167.  
  168. NEW 3A     S5     C:\HAMBASE\HBNEW.A                                
  169. HBA AA0A   NO0GFT C:\HAMBASE\HAMBASE.A                                        
  170. HBA WA0RVX KA1RTW C:\HAMBASE\HAMBASE.B                                        
  171. HBA KA1RTX WA2LKX C:\HAMBASE\HAMBASE.C                                        
  172. HBA VE0DP  VE8YQ  C:\HAMBASE\CANADA.A                                         
  173. HBT 4K3BB  YL3KZ  C:\HAMBASE\HBTEXT.A
  174. HBT 0T6C   ZZ9A   C:\HAMBASE\HBTEXT.B
  175. HBT AD0H   WT7M   C:\HAMBASE\HBTEXT.C
  176. HBT 1A0    ZZ0T   C:\HAMBASE\HBTEXT.D
  177.  
  178. The code at the left indicates the format of the file so that HamBase
  179. can use the correct search algorithm on the file.
  180.  
  181. As you can see, the file HBNEW.A, which contains updates and changes
  182. entered by the user is searched first.  Only if the call is not found
  183. in that file will HamBase go on to search the other files.
  184.  
  185. Next, the HBA files contain data compressed in the proprietary HamBase
  186. compression scheme.  US and Canadian data and updates are compressed
  187. using this method.  Files are searched only if the callsign lies in
  188. the range shown in columns two and three.
  189.  
  190. Finally, the HBT files contain ascii data with one line per call sorted
  191. in alphabetical order.  In this example, HBTEXT.A contains the Russian
  192. callsign data, HBTEXT.B contains DX QSL data, HBTEXT.C contains our club
  193. list which gets merged into the HAMBASE files when they are created, and
  194. HBTEXT.D contains an older DX QSL file.
  195.  
  196. MULTIPLE MAPS
  197. -------------
  198.  
  199. It is sometimes desirable to separate two or more sets of data.  In this
  200. case, it is possible to generate more than one map.  You can have one
  201. map for the DX data, one map for the US data, one map for the Russian
  202. data, one map for the packet BBS data, one map for the Old Call data,
  203. one map for your list of friends,and so on.  To change maps, go to
  204. Configure - Data Paths - Special Files, and change the name of the
  205. map file to the new one you want to use.
  206.  
  207. FILE FORMATS
  208. ------------
  209.  
  210. NEW  and  HBT
  211.  
  212. The NEW files contain address information in any order.  HamBase uses
  213. an advanced text searching algorithm to linearly search this file.
  214.  
  215. As you can see, if the file gets very large, the search speed will slow
  216. down.  Normally, files of less than 500K are not a problem.  However,
  217. it may be advantageous to sort the file using DOS SORT if it is small,
  218. QSORT (a shareware sort program for large files), or the sort utility
  219. of a database or spreadsheet program.
  220.  
  221. Once a file is sorted into alphabetical order, it can be used as an HBT file.
  222. HBT files are searched with a binary search which requires only
  223. a few disk reads to find any given record.
  224.  
  225. QSORT HBNEW.A HBTEXT.X will sort HBNEW.A and put the resulting sorted file
  226. into HBTEXT.X.  You can enter HBTEXT.X (or whatever you call it) in the
  227. MAP file manually, or you can delete HBNEW.A and generate a map file
  228. using the internal HamBase commands.  If you use the internal HamBase
  229. command ( CONFIGURE | DATA | GENERATE ), the HBTEXT file will be added
  230. to the end of the MAP file.  It will then not be searched before the
  231. HBA files.  If you want to search for revised addresses you have entered
  232. for hams in the HBA files, you must manually edit the HB93.MAP file to
  233. the correct order.
  234.  
  235. HBT files can also be merged together using the MERGE utility program
  236. which is provided on the program disk.  This will speed up access time
  237. because it does not take HamBase much longer to search a very large
  238. sorted text file than a small one.  It does take twice as long to
  239. search two small ones.  So, use MERGE as follows.
  240.  
  241.      MERGE HBTEXT.A HBTEXT.B HBTEXT.X
  242.  
  243. to merge the HBTEXT.A file and the HBTEXT.B file into the new file HBTEXT.X.
  244.  
  245. Then, remove HBTEXT.A and HBTEXT.B from your HamBase directory, rename
  246. HBTEXT.X as HBTEXT.A, and generate a new map file to reflect the changes.
  247.  
  248. ------------------------------------------------------------------------
  249.  
  250. MERGE will a automatically remove deleted records from HBNEW.A
  251. To merge your new data with an existing HBTEXT.A file:
  252.     
  253.     COPY HBTEXT.A A:                    Backup your HBTEXT.A somewhere
  254.     COPY HBNEW.A A:                     Backup your HBNEW file somewhere
  255.     
  256.     QSORT HBNEW.A TEMP.1                to get the records in order
  257.     
  258.     MERGE HBTEXT.A TEMP.1 TEMP.2        merges old data with new data
  259.     
  260.     DEL HBTEXT.A                        throw away old data
  261.     DEL HBNEW.A                         throw away new data
  262.     RENAME TEMP.2 HBTEXT.A              Make the merged data an HBTEXT file
  263.     
  264.     HB                                  CONFIGURE - DATA PATHS - GENERATE
  265.                                         Generate a new map to the data.
  266.         
  267. Remember to always make backups before doing these kinds of operations.
  268. When something goes wrong - and it will - you can always go back and
  269. start over.
  270. ------------------------------------------------------------------------
  271.               
  272. A few words about HBNEW.A
  273. -------------------------
  274. Deleted records are not immediately removed from the HBNEW.A file
  275. that HamBase uses to store new and changed records.  They are
  276. marked by ORing the first character with 0x80.  The character will
  277. therefore appear to be a strange looking graphic character when reading
  278. this file with an editor.  Beware of editors that modify these characters
  279. automatically.
  280.  
  281. As the files gets larger, HamBase will ask from time to time if
  282. you want to remove deleted records to save space in the file. Until
  283. they are removed, you can go back and examine them, or even undelete
  284. them with a simple change of the first character in the line.
  285.  
  286. If a record appears twice in this file with the same callsign, only
  287. the first occurrence will be visible to HamBase.
  288.  
  289. Any file can be added to the HB93.MAP with the designator NEW.
  290. HamBase will search it for callsigns in the first few columns.
  291.        
  292. As the HBNEW.A file can get very large, you will need an editor that
  293. can handle large files, or you should sort it and rename it as an
  294. HBTEXT file.
  295.  
  296. The BINGO shareware editor can edit files of any length if you
  297. have enough disk space.
  298.  
  299. The QSORT shareware program will sort files of any length if you
  300. have enough disk space.
  301.  
  302. Neither of these programs are j-Com products.  We are only recommending
  303. them so you know what to look for if you do not already have utilities
  304. to do these things.
  305. ---------------------------------------------------------------------
  306.  
  307. HBT Files
  308. ---------
  309. HBT files are text files sorted into alphabetical order.  If an HBT
  310. file is labelled as a NEW file, it will be searched linearly.  If a
  311. NEW file is sorted, and labelled as an HBT file, it will be searched
  312. with a binary search.
  313.  
  314. The main difference betweeen NEW and HBT files ( HBNEW.x and HBTEXT.x)
  315. is that HBT files are sorted and NEW files are not.  NEW files also
  316. contain records marked for deletion.  HBT files must never contain
  317. a duplicate callsign.  
  318.  
  319. MERGE FILE NUL NUL will check for duplicates in file FILE.  The DOS
  320. file NUL is a special file for sending output to the bit bucket -
  321. i.e. nowhere.
  322.  
  323. Record formats
  324. --------------
  325. Text data in NEW and HBT files may be in one of several formats. US
  326. calls are usually stored in comma delimited form broken into fields.
  327. The format can be seen using the BROWSE | CALLS menu, or by exporting
  328. HAMBASE data in comma delimited format without the county information.
  329. (County names are looked up according to the zip code.)
  330.  
  331. The standard text data format is:
  332.  
  333. CALL,CLASS,FIRST NAME,LAST NAME,STREET,CITY,STATE,ZIP CODE,BIRTHDATE
  334.  
  335. CLASS is always one character long.
  336.  
  337. Names may not contain punctuation other than apostrophes.
  338.  
  339. The state must be 2 characters long.
  340.  
  341. ZIP CODE must be numeric only.
  342.  
  343. BIRTHDATE is in Julian form (2 digit year and 3 digit day of year).
  344.  
  345. There must be exactly 8 commas on the line.
  346.  
  347. This format of data is formatted into an address according to a set
  348. of rules.
  349.  
  350. Text format:
  351.  
  352. A second format is used for DX data and other information which
  353. does not fit the standard format above developed for use with US
  354. callsign data:
  355.  
  356. CALL,CLASS,LINE 1|LINE 2|LINE 3|LINE 4
  357.  
  358. This format is useful for different forms of data.  The callsign must
  359. be terminated with a comma.  There must be a single character CLASS,
  360. and then there are four lines separated by the | symbol.  Clearly, the
  361. | symbol cannot appear in the data itself.
  362.  
  363. Free form:
  364.  
  365. CALL,CLASS,TEXT
  366.  
  367. The simplest format of all is based on just the callsign, a single
  368. character class, and free form text.  A word wrap function displays the
  369. text in the address window without regard to what falls on each line
  370. other than to attempt to not split words.
  371.  
  372. HamBase distinguishes the display formats by counting the number of
  373. commas and the number of | symbols.  If there aren't 8 commas, or
  374. 3 | symbols, the free form display method is used.
  375.  
  376.  
  377. Accessing HamBase from other programs
  378. -------------------------------------
  379.  
  380. Authors of logging programs and BBS systems are encouraged to write
  381. access "doors" to HamBase. We highly recommend that all access to
  382. the program be done by calling the HamBase program with the callsign
  383. as an argument and collecting the output stream in a file.
  384.  
  385. HB WA9L >TEMP   This will look up the call and output to a temp
  386.                 file which can be read by the calling program.
  387.  
  388. We will always try to maintain versions of HamBase which will
  389. accept a callsign command line argument and output to the standard
  390. output stream.
  391.  
  392. The following methods are used by various logging programs and
  393. BBS programs.  We will attempt to provide this method of access
  394. in future releases, but cannot guarantee that they will always work.
  395.  
  396.                 
  397. HB -o=TEMP WA9L >NUL   This will output in comma delimited form and
  398.                        discard other output.
  399.                        
  400. HB -~=TEMP WA9L >NUL   Same as -o, but includes county in the data.
  401.  
  402. HB -i=INLIST >NUL    Method for reading a list of calls.
  403.  
  404. HamBase 3.0 requires more memory than the previous versions.  If the
  405. calling program does not allocate enough memory, you may get an
  406. out of memory error message.  If this occurs, you can use the 
  407. SHROOM utility to swap the calling program to disk or extended memory
  408. so that you will have enough base memory available for HamBase.
  409.  
  410. SHROOM is a shareware program available on CompuServe GO IBMSYS Lib 3,
  411. and on the Mountain Retreat BBS (408) 335-4595.
  412.  
  413.  
  414. RAM DISK
  415. --------
  416. Performance of HamBase can be improved by the judicious use of a RAM
  417. disk.  If you are doing a lot of lookups that involve the county,
  418. it would be a very good idea to copy the county name file HBCOUNTY.A
  419. to your RAM disk and change the configuration of the Special Files
  420. to point to it.  This will speed up all US lookups.
  421.  
  422. You can also install HBNEW.A on the RAM disk for a further improvement
  423. in speed if you have added a lot of new calls yourself.  There is a
  424. danger in placing HBNEW.A on a RAM disk.  If you add any new calls,
  425. it will be necessary to copy the file from the RAM disk to your hard
  426. drive before turning off the computer.
  427.  
  428. The Lookup display shows which file the data is retrieved from.  If you
  429. are making extensive use of any one file, it can be put in the RAM
  430. disk for maximum performance.
  431.  
  432. If you have a large RAM disk, the name index can be placed on it for
  433. faster name browsing.
  434.  
  435.  
  436. Technical questions regarding HamBase should be sent via email to
  437. the internet address 72470.3171@compuserve.com or the CompuServe
  438. address 72470,3171.  NetMail by fidonet can be sent to Peter Jennings
  439. 1:216/506, or messages can be left on the Mountain Retreat BBS
  440. (408) 335-4595.
  441.  
  442.